This page last changed on Dec 02, 2014 by kgomes.
Current Applications
Design Documentation
  1. The goals for the ESP GUI Application are:
    1. A graphical interface to allow the user to plan a mission for the ESP
    2. The GUI can take a mission plan and generate a valid mission script to deploy on the ESP
    3. The GUI will provide functionality to manage the data from the ESP. This data consists of:
      1. Various Ruby scripts
      2. Image analysis of the probe arrays
      3. Ancillary instrument data
      4. Events and data from log file (parsing)
    4. The GUI will provide a visual representation of the state of the ESP
      1. Currently user has to look through log file and mentally visualize state of system
      2. GUI should display visual representation of the instrument and its components
      3. Take instrument state from log file and produce graphical representation that will depict the current state of the instrument
      4. The state visualization should be able to playback a mission run from a log file and step the user through instrument states
    5. The GUI application should be focused on transitioning the ESP to a user community (not necessarily a development community)
  2. Use Cases
    1. ESP Configuration In Lab
      1. Mission plan is created
      2. Pucks are loaded
      3. Reagents are loaded
      4. Mission script is loaded
    2. ESP Deployment
      1. Shore station is configured
        1. Nothing from a GUI perspective
      2. FTP file store is configured
        1. Once the FTP server is up and running, the user will log in to the ESP web site
        2. If no mission has been created, the user creates a new mission for the ESP (can be empty)
        3. The user configures the mission FTP server in the web application
          1. Protocol (FTP/SFTP)
          2. Server hostname
          3. Port number
          4. Base directory for deployment files
          5. Username (or anonymous)
          6. Password (or email)
          7. Name and location of the log file (default is deduced from the type of mission e.g. real -> real.log)
        4. The user saves the FTP configuration in web application
        5. The user logs out
        6. Server spins up a monitoring worker process that points to the FTP server configured for the mission
        7. Process crawls FTP server site and examines each directory and file
        8. If the directory/file is different that what is in the deployment directory in the ESP repository, sync file from FTP server to repository.
        9. Update catalog entry for directory/file
        10. If the log file was updated, spin up process to parse the log file.
      3. ESP mobilized on ship
        1. Verify the ESP if functioning properly by checking files on the FTP station
          1. Make sure ancillary instruments are logging
          2. Check for any errors
          3. Makes sure environment sensors are reporting that all systems are go (humidity, power, etc.)
      4. ESP deployed
        1. Monitor ESP log files during deployment as was done in mobilization.
    3. ESP Operations
      1. ESP is sitting idle
      2. ESP processes sample
      3. ESP errors and halts
      4. Operator interacts with ESP
    4. ESP Data Analysis
      1. User enables image analysis
        1. The proper GAL file is uploaded to the mission repository
        2. The application sees the GAL file and does an automated analysis of the images.
    5. ESP Recovery
      1. Recover ESP with ship
      2. Demobilize the ESP off the ship
      3. Decommission the FTP server
      4. Decommission the shore station
  3. Requirements
    1. Assumptions
    2. Glossary
    3. Open Questions
  4. Interface Documents
    1. ESP Log Interface
      1. Parsing the ESP log file
    2. Real-Time ESP state update protocol framework
  5. GUI Application Design
    1. Object Model
    2. Data Model
    3. Data Repository
  6. Developer Documentation
Outstanding Issues

PDR.xls (application/vnd.ms-excel)
PDR.ppt (application/vnd.ms-powerpoint)
ESPGUIDMthingstotrackextractfromlog.htm (text/html)
engineeringTour.pdf (application/pdf)
ESPcoreLib.pdf (application/pdf)
ESPenviroment.pdf (application/pdf)
usersAndGroups.pdf (application/pdf)
overview.pdf (application/pdf)
ESPslide.pdf (application/pdf)
ESPservos.pdf (application/pdf)
ESPi2c.pdf (application/pdf)
ESPshore.pdf (application/pdf)
ESPsensors.pdf (application/pdf)
ESPparams.pdf (application/pdf)
ESPaxes.pdf (application/pdf)
ESPerrors.pdf (application/pdf)
ESPerrors.pdf (application/pdf)
ESPManual_v1.pdf (application/pdf)
ESP Fluidics v2_2 small.pdf (application/pdf)
Document generated by Confluence on Feb 03, 2026 14:16